Meshtastic App/com.geeksville.mesh/[androidJvm]MeshProtos/UserOrBuilder

UserOrBuilder

interface UserOrBuilder : MessageOrBuilder

Inheritors

Functions

Link copied to clipboard
abstract fun getHwModel(): MeshProtos.HardwareModel

TBEAM, HELTEC, etc...
Starting in 1.2.11 moved to hw_model enum in the NodeInfo object.
Apps will still need the string here for older builds
(so OTA update can find the right image), but if the enum is available it will be used instead.
Content copied to clipboard
.meshtastic.HardwareModel hw_model = 5;
Link copied to clipboard
abstract fun getHwModelValue(): Int

TBEAM, HELTEC, etc...
Starting in 1.2.11 moved to hw_model enum in the NodeInfo object.
Apps will still need the string here for older builds
(so OTA update can find the right image), but if the enum is available it will be used instead.
Content copied to clipboard
.meshtastic.HardwareModel hw_model = 5;
Link copied to clipboard
abstract fun getId(): String

A globally unique ID string for this user.
In the case of Signal that would mean +16504442323, for the default macaddr derived id it would be !<8 hexidecimal bytes>.
Note: app developers are encouraged to also use the following standard
node IDs "^all" (for broadcast), "^local" (for the locally connected node)
Content copied to clipboard
string id = 1;
Link copied to clipboard
abstract fun getIdBytes(): ByteString

A globally unique ID string for this user.
In the case of Signal that would mean +16504442323, for the default macaddr derived id it would be !<8 hexidecimal bytes>.
Note: app developers are encouraged to also use the following standard
node IDs "^all" (for broadcast), "^local" (for the locally connected node)
Content copied to clipboard
string id = 1;
Link copied to clipboard
abstract fun getIsLicensed(): Boolean

In some regions Ham radio operators have different bandwidth limitations than others.
If this user is a licensed operator, set this flag.
Also, "long_name" should be their licence number.
Content copied to clipboard
bool is_licensed = 6;
Link copied to clipboard
abstract fun getIsUnmessagable(): Boolean

Whether or not the node can be messaged
Content copied to clipboard
optional bool is_unmessagable = 9;
Link copied to clipboard
abstract fun getLongName(): String

A full name for this user, i.e. "Kevin Hester"
Content copied to clipboard
string long_name = 2;
Link copied to clipboard
abstract fun getLongNameBytes(): ByteString

A full name for this user, i.e. "Kevin Hester"
Content copied to clipboard
string long_name = 2;
Link copied to clipboard
abstract fun getMacaddr(): ByteString

Deprecated in Meshtastic 2.1.x
This is the addr of the radio.
Not populated by the phone, but added by the esp32 when broadcasting
Content copied to clipboard
bytes macaddr = 4 [deprecated = true];
Link copied to clipboard
abstract fun getPublicKey(): ByteString

The public key of the user's device.
This is sent out to other nodes on the mesh to allow them to compute a shared secret key.
Content copied to clipboard
bytes public_key = 8;
Link copied to clipboard
abstract fun getRole(): ConfigProtos.Config.DeviceConfig.Role

Indicates that the user's role in the mesh
Content copied to clipboard
.meshtastic.Config.DeviceConfig.Role role = 7;
Link copied to clipboard
abstract fun getRoleValue(): Int

Indicates that the user's role in the mesh
Content copied to clipboard
.meshtastic.Config.DeviceConfig.Role role = 7;
Link copied to clipboard
abstract fun getShortName(): String

A VERY short name, ideally two characters.
Suitable for a tiny OLED screen
Content copied to clipboard
string short_name = 3;
Link copied to clipboard
abstract fun getShortNameBytes(): ByteString

A VERY short name, ideally two characters.
Suitable for a tiny OLED screen
Content copied to clipboard
string short_name = 3;
Link copied to clipboard
abstract fun hasIsUnmessagable(): Boolean

Whether or not the node can be messaged
Content copied to clipboard
optional bool is_unmessagable = 9;